Add comment to clarify the use of `str'

diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el
index d1fa5c7f12076bb8b281123571067683d5a0a711..ddfa7a3e15c712e6e9aa31897c11a47027c26514 100644 (file)
--- a/lisp/erc/erc.el
+++ b/lisp/erc/erc.el
@@ -5443,6 +5443,8 @@ This returns non-nil only if we actually send anything."
     (let ((str input)
           (erc-insert-this t))
       (setq erc-send-this t)
+      ;; The calling convention of `erc-send-pre-hook' is that it
+      ;; should change the dynamic variable `str'.
       (run-hook-with-args 'erc-send-pre-hook input)
       (when erc-send-this
         (if (or (string-match "\n" str)